Feature/bump mlx #75

LeonNissen · 2024-11-18T19:30:25Z

Update MLX Version

⚙️ Release Notes

Breaking Changes: This pull request introduces additional breaking changes.
Version Updates:

mlx-swift has been updated to version 0.18.1.
mlx-swift-examples has been updated to version 1.18.1.
LLMLocalSchema can now be update with other parameters.
The ChatTemplate used by swift-transformers can be overwritten.
The LLMContext can be overwritten with a custom context ([[String: String]]).

📝 Code of Conduct & Contributing Guidelines

By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines:

I agree to follow the Code of Conduct and Contributing Guidelines.

add note to README

fix memory selection

# Conflicts: # Package.swift # Sources/SpeziLLMLocal/LLMLocalSchema.swift # Sources/SpeziLLMLocal/LLMLocalSession+Generate.swift # Sources/SpeziLLMLocal/LLMLocalSession+Setup.swift # Tests/UITests/TestAppUITests/TestAppLLMLocalUITests.swift

philippzagar · 2024-11-28T16:27:09Z

@LeonNissen #78 tackles a breaking change from the mlx-swift-examples library, feel free to close out the PR as soon as this bump PR is merged! 🚀
Same goes for the issue: #77

codecov · 2024-12-05T23:01:23Z

Codecov Report

Attention: Patch coverage is 0% with 147 lines in your changes missing coverage. Please review.

Project coverage is 38.52%. Comparing base (8bf0a2f) to head (021fe77).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
...urces/SpeziLLMLocal/Mock/LLMLocalMockSession.swift	0.00%	73 Missing ⚠️
...urces/SpeziLLMLocal/LLMLocalSession+Generate.swift	0.00%	37 Missing ⚠️
Sources/SpeziLLMLocal/LLMLocalSession+Update.swift	0.00%	10 Missing ⚠️
...eziLLMLocal/Helpers/LLMContext+FormattedChat.swift	0.00%	8 Missing ⚠️
Sources/SpeziLLMLocal/LLMLocalPlatform.swift	0.00%	7 Missing ⚠️
Sources/SpeziLLMLocal/LLMLocalSchema.swift	0.00%	6 Missing ⚠️
...eziLLMLocal/Configuration/LLMLocalParameters.swift	0.00%	2 Missing ⚠️
Sources/SpeziLLMLocal/LLMLocalSession+Setup.swift	0.00%	2 Missing ⚠️
Sources/SpeziLLM/Models/LLMContextEntity.swift	0.00%	1 Missing ⚠️
Sources/SpeziLLMLocal/LLMLocalSession.swift	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #75      +/-   ##
==========================================
+ Coverage   36.24%   38.52%   +2.28%     
==========================================
  Files          64       65       +1     
  Lines        2503     2355     -148     
==========================================
  Hits          907      907              
+ Misses       1596     1448     -148

Files with missing lines	Coverage Δ
Sources/SpeziLLM/Models/LLMContextEntity.swift	`35.00% <0.00%> (ø)`
Sources/SpeziLLMLocal/LLMLocalSession.swift	`0.00% <0.00%> (ø)`
...eziLLMLocal/Configuration/LLMLocalParameters.swift	`0.00% <0.00%> (ø)`
Sources/SpeziLLMLocal/LLMLocalSession+Setup.swift	`0.00% <0.00%> (ø)`
Sources/SpeziLLMLocal/LLMLocalSchema.swift	`0.00% <0.00%> (ø)`
Sources/SpeziLLMLocal/LLMLocalPlatform.swift	`0.00% <0.00%> (ø)`
...eziLLMLocal/Helpers/LLMContext+FormattedChat.swift	`0.00% <0.00%> (ø)`
Sources/SpeziLLMLocal/LLMLocalSession+Update.swift	`0.00% <0.00%> (ø)`
...urces/SpeziLLMLocal/LLMLocalSession+Generate.swift	`0.00% <0.00%> (ø)`
...urces/SpeziLLMLocal/Mock/LLMLocalMockSession.swift	`0.00% <0.00%> (ø)`

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8bf0a2f...021fe77. Read the comment docs.

philippzagar

Thanks @LeonNissen for the great PR! 🚀 Great to see that SpeziLLM is continuously moving forward!
I had some thoughts in-line, feel free to follow up on them, then we can merge the PR soon (especially in order to fix e.g. #77)
Regarding the failing patch test coverage: No need to worry about that!

Update: As SpeziLLM currently doesn't compile at all (because of the MLX semantic versioning issue described above), I pinned the MLX library versions to specific versions in #80
Please take that into consideration when pinning your MLX dependencies!

Package.swift

Sources/SpeziLLMLocal/Configuration/LLMLocalParameters.swift

Sources/SpeziLLMLocal/Helpers/LLMContext+formatForTransformersChat.swift

Sources/SpeziLLM/Models/LLMContextEntity.swift

Tests/UITests/TestApp/LLMLocal/LLMLocalChatTestView.swift

Sources/SpeziLLMLocal/LLMLocalSession+Generate.swift

Sources/SpeziLLMLocal/LLMLocalSession.swift

PSchmiedmayer

Thank you for the review @philippzagar! Made some small changes to the tagged versions to clarify semantic versioning expressiveness in the Package file; thank you for all the feedback!

philippzagar · 2024-12-09T07:40:04Z

Thank you for the review @philippzagar! Made some small changes to the tagged versions to clarify semantic versioning expressiveness in the Package file; thank you for all the feedback!

Thanks @PSchmiedmayer for looking into that!
Regarding the semantic versioning changes: I pinned both MLX libraries, just to be sure. I didn't use .upToNextMinor() as it is apparently deprecated? See: https://developer.apple.com/documentation/packagedescription/package/dependency/requirement-swift.enum/uptonextminor(from:)
The alternative appears to be: https://developer.apple.com/documentation/packagedescription/package/dependency/package(url:_:)-1r6rc

And yes, the exact: init is definitely a better choice than branch: for sure, thanks!

PSchmiedmayer · 2024-12-09T19:57:22Z

@philippzagar The constraint on the Requirement type was deprecated; Version still has a valid static function that we are using in the Package: https://developer.apple.com/documentation/swift/range/uptonextminor(from:). TBH a bit confusing and strange that they don't point to the non-deprecated from the deprecated version 🤷‍♂️

philippzagar · 2024-12-09T20:44:22Z

Thank you for the review @philippzagar! Made some small changes to the tagged versions to clarify semantic versioning expressiveness in the Package file; thank you for all the feedback!

Oh I see, was a bit confused as well about that..

LeonNissen · 2024-12-09T21:35:15Z

Thanks @LeonNissen for the great PR! 🚀 Great to see that SpeziLLM is continuously moving forward! I had some thoughts in-line, feel free to follow up on them, then we can merge the PR soon (especially in order to fix e.g. #77) Regarding the failing patch test coverage: No need to worry about that!

Update: As SpeziLLM currently doesn't compile at all (because of the MLX semantic versioning issue described above), I pinned the MLX library versions to specific versions in #80 Please take that into consideration when pinning your MLX dependencies!

Thank you so much for you in-depth feedback! Lets just discuss the final comments and finish up to tag a new version 👍

philippzagar

Thanks for incorporating the feedback @LeonNissen. 🚀
As mentioned, there are definitely some points in there that we should make a bit more flexible and documented in the future, but they are definitely fine for now!

Sources/SpeziLLMLocal/SpeziLLMLocal.docc/SpeziLLMLocal.md

LeonNissen · 2024-12-11T16:13:39Z

Awesome, thank you, @philippzagar! Your feedback has truly improved the PR 🥇

# *Update MLX Version* ## ⚙️ Release Notes **Breaking Changes**: This pull request introduces additional breaking changes. Version Updates: - mlx-swift has been updated to version 0.18.1. - mlx-swift-examples has been updated to version 1.18.1. - `LLMLocalSchema` can now be update with other parameters. - The `ChatTemplate` used by `swift-transformers` can be overwritten. - The `LLMContext` can be overwritten with a custom context (`[[String: String]]`). ## 📝 Code of Conduct & Contributing Guidelines By submitting creating this pull request, you agree to follow our [Code of Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md): - [x] I agree to follow the [Code of Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md). --------- Co-authored-by: Leon Nissen <> Co-authored-by: Paul Schmiedmayer <[email protected]>

Leon Nissen added 17 commits October 15, 2024 18:52

intermediate commit

3ba2134

add simulator check

519dac1

improve code to PR comments

85df6f1

fix REUSE

d74b647

adjust UITest project

03fc955

add note to README

update readme

accb8ef

intermediate commit

b2ceaa5

fix liniting issues

4260756

add comments

e99b35d

fix memory selection

intermediate commit

fded07f

remote swiftlint

4480b8c

intermediate commit

768cbfc

skip test on release ipad

3ea48b0

skip openai test due to same issue

a251d8a

bump to mlx-swift-examples 1.18.1

d44f38d

bump version

89c52c8

Merge branch 'main' into feature/bump-mlx

66efe28

# Conflicts: # Package.swift # Sources/SpeziLLMLocal/LLMLocalSchema.swift # Sources/SpeziLLMLocal/LLMLocalSession+Generate.swift # Sources/SpeziLLMLocal/LLMLocalSession+Setup.swift # Tests/UITests/TestAppUITests/TestAppLLMLocalUITests.swift

LeonNissen self-assigned this Nov 18, 2024

add chatTemplate overwrite

1374334

philippzagar mentioned this pull request Nov 28, 2024

Fix modelConfiguration.prepare(prompt: formattedChat) compile error #78

Closed

philippzagar mentioned this pull request Nov 28, 2024

Value of type 'ModelConfiguration' has no member 'prepare' #77

Closed

1 task

Leon Nissen added 4 commits December 1, 2024 13:51

intermediate commit

547556d

intermediate commit

8f2984f

intermediate commit

1f9feb7

fix swiftlint

305f05c

LeonNissen marked this pull request as ready for review December 5, 2024 21:26

intermediate commit

3eb07e1

LeonNissen requested a review from PSchmiedmayer December 5, 2024 22:45

LeonNissen requested a review from philippzagar December 5, 2024 23:05

philippzagar requested changes Dec 8, 2024

View reviewed changes

philippzagar added the enhancement New feature or request label Dec 8, 2024

PSchmiedmayer added 2 commits December 8, 2024 17:03

Update Dependencies & Merge

bd71161

Merge branch 'main' into feature/bump-mlx

5c028a3

PSchmiedmayer reviewed Dec 9, 2024

View reviewed changes

adjust to PR comments

865dc3b

Leon Nissen added 3 commits December 10, 2024 12:19

adapt to PR comments

79470e5

fix swiftlint

c87abd2

fix LLMLocalMockSession vs LLMLocalSession

021fe77

philippzagar self-requested a review December 11, 2024 09:56

philippzagar approved these changes Dec 11, 2024

View reviewed changes

Sources/SpeziLLMLocal/SpeziLLMLocal.docc/SpeziLLMLocal.md Show resolved Hide resolved

LeonNissen closed this Dec 11, 2024

LeonNissen reopened this Dec 11, 2024

LeonNissen enabled auto-merge (squash) December 11, 2024 16:14

PSchmiedmayer disabled auto-merge December 11, 2024 17:10

PSchmiedmayer merged commit fd9f1ca into main Dec 11, 2024
36 of 38 checks passed

PSchmiedmayer deleted the feature/bump-mlx branch December 11, 2024 17:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/bump mlx #75

Feature/bump mlx #75

LeonNissen commented Nov 18, 2024 •

edited

Loading

philippzagar commented Nov 28, 2024 •

edited

Loading

codecov bot commented Dec 5, 2024 •

edited

Loading

philippzagar left a comment •

edited

Loading

PSchmiedmayer left a comment

philippzagar commented Dec 9, 2024

PSchmiedmayer commented Dec 9, 2024

philippzagar commented Dec 9, 2024

LeonNissen commented Dec 9, 2024

philippzagar left a comment

LeonNissen commented Dec 11, 2024

Feature/bump mlx #75

Feature/bump mlx #75

Conversation

LeonNissen commented Nov 18, 2024 • edited Loading

Update MLX Version

⚙️ Release Notes

📝 Code of Conduct & Contributing Guidelines

philippzagar commented Nov 28, 2024 • edited Loading

codecov bot commented Dec 5, 2024 • edited Loading

Codecov Report

philippzagar left a comment • edited Loading

Choose a reason for hiding this comment

PSchmiedmayer left a comment

Choose a reason for hiding this comment

philippzagar commented Dec 9, 2024

PSchmiedmayer commented Dec 9, 2024

philippzagar commented Dec 9, 2024

LeonNissen commented Dec 9, 2024

philippzagar left a comment

Choose a reason for hiding this comment

LeonNissen commented Dec 11, 2024

LeonNissen commented Nov 18, 2024 •

edited

Loading

philippzagar commented Nov 28, 2024 •

edited

Loading

codecov bot commented Dec 5, 2024 •

edited

Loading

philippzagar left a comment •

edited

Loading